Cream of the Crop 22

home *** CD-ROM | disk | FTP | other *** search

/ Cream of the Crop 22 / Cream of the Crop 22.iso / comm / te150a.zip / TEDIT.DOC < prev next >

Wrap

Text File | 1996-10-11 | 68KB | 1,366 lines

█▌ █▌ ▀█ ▀ █▌ ▀██▀▀ ▄█ █▄ ██▀▄ ██▀▀█▄ ▄█▀▀█▄ ▄█▀▀█▄ ▄█▀▀██ █▌ ▀██▀▀ ██▄ ██ ██ ██▄ ██ ██ ██ ██ ██▀ ▄▄ ██ ██ ██▄ ██▄ ▀▀▀ ▀▀▀▀ ▀▀ ▀▀▀▀ ▀▀▀▀ ▀▀▀▀ ▀▀▀▀ ▀▀ ▀▀▀ ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄ ▄██▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀██▄ ▐█▀ TurboEDIT ▀█▌ █ Version 1.50a ■ Documentation █ ▌ Copyright (C) 1995-1996, by Steve Blinch ▐ │ of Mikerosoft Productions │ [note: lines with a pipe (|) after them have been modified since v1.40a] | ┌───────────────────────────────────────────────────────────────────────┐ │ ░░░░░ │ TurboEDIT Description │ ░░░░░ │ └───────────────────────────────────────────────────────────────────────┘ TurboEDIT is an online message editor designed to allow users to post messages to other users quickly and easily, with most (if not all) of the benefits of a standard text editor. Just a few of TurboEDIT's many features include: ■» Text-editor style editing keys ■» Full-featured quoting options ■» Taglines + IntelliTag topic-related tagline searching ■» Message text spellchecker ■» Tagline keyword searching (users can search for certain taglines) ■» Highly configurable message censoring ■» Phrase expansions (i.e. "l8r" expands to "Later!", etc) ■» 100% configurable colors (user-config and SysOp-config) ■» Group-specific lockouts (keep certain users out of certain echos) ■» Supports Mail Reader style tagline macros (i.e. @N@ = Username) ■» User-defineable taglines ■» Separate configuration for each user ■» Personal signatures for each user ■» Personal spellchecker dictionaries for each user if desired ■» Complete language editor ■» Compatible with Blue Wave and other offline mail readers ■» Area-sensitive toggles for High ASCII filtering, sigs, taglines, censoring, expansions, & tagkeywords ■» And many, many more! ┌───────────────────────────────────────────────────────────────────────┐ │ ░░░░░ │ Legal Stuff │ ░░░░░ │ └───────────────────────────────────────────────────────────────────────┘ ■» Disclaimer As a formality, this had to be included. TurboEDIT *should* be 100% safe to use on just about any IBM or compatible, but... TurboEDIT comes with no warranty of any kind, either express or implied, including but not limited to implied warranties of mer- chantability and fitness for a particular purpose, with respect to this software and accompanying documentation. In no event shall Steve Blinch, Michael Helliker, or any other member of Mikerosoft Productions be liable for any damages (including loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use or inability to use this software, even if Mikerosoft Productions has been advised of the possibility of such damages. The execution of TEDIT.EXE or any other executable packaged with TurboEDIT signifies your agreement to the above terms. ■» Distribution TurboEDIT may be freely copied and distributed and provided that the following conditions are met: 1) TurboEDIT must be distributed in UNALTERED form, with all doc- umentation and support files. 2) The TurboEDIT executables may not be modified, disassembled, cross-assembled, re-assembled, or in any way changed without express written permission from the author (Steve Blinch). 3) Only the UNREGISTERED version of TurboEDIT may be distributed. Registered copies (and/or registration keys) may NOT, for any purpose, be used by any person other than the person to whom the key belongs. 4) It is preferred that the original compression style (the RAR self extractor) is maintained. However, if absolutely necessary, the compression format may be changed (preferably to the regular RAR format, but if a change to another archiver is necessary, so be it.) 5) No fee may be charged for the distribution of TurboEDIT. ■» Use of TurboEDIT TurboEDIT may be used unregistered for a single evaluation period of not more than 30 days, to allow the user to see if it meets his or her needs. After this period has expired, the user MUST either register TurboEDIT with the author (Steve Blinch) or stop using it. ┌───────────────────────────────────────────────────────────────────────┐ │ ░░░░░ │ Registration │ ░░░░░ │ └───────────────────────────────────────────────────────────────────────┘ Please see REGISTER.DOC for important information about registering. ┌───────────────────────────────────────────────────────────────────────┐ │ ░░░░░ │ Authenticity Verification │ ░░░░░ │ └───────────────────────────────────────────────────────────────────────┘ Due to a recent switch to the RAR archiver, our archives now have AV (Authenticity Verification) signatures. When you run the TurboEDIT self-extractor (TE????.EXE), the TurboEDIT logo should come up, and then you should see the following: ─[cut]─────────────────────────────────────────────────────────────── Verifying authenticity information ... Ok Extracting (filename) Ok . . . Archive TE150A.EXE created at hh:mm:ss dd mmm yyyy by Mikerosoft Productions Done ─[cut]─────────────────────────────────────────────────────────────── If the AV signature is missing, the verification fails, or our name (Mikerosoft Productions) does not appear as shown above, the software has been altered since we released it. ┌───────────────────────────────────────────────────────────────────────┐ │ ░░░░░ │ RemoteAccess │ ░░░░░ │ └───────────────────────────────────────────────────────────────────────┘ TurboEDIT has been designed to be useable with many different BBS systems. As long as they produce MSGTMP. and DORINFO1.DEF/DOOR.SYS, TurboEDIT should work with them. However, we have added special additional features for RemoteAccess BBS systems, as we feel that RA is one of the best BBS systems avail- able. Any option in this documentation that's marked with [RA] means that it's for RemoteAccess BBS systems only, and is not available with other BBS programs. ┌───────────────────────────────────────────────────────────────────────┐ │ ░░░░░ │ System Requirements │ ░░░░░ │ └───────────────────────────────────────────────────────────────────────┘ TurboEDIT requires the following to run: ■» An IBM XT/AT/386/486/Pentium/P6+ or compatible ■» A modem, 300-115200 BPS ■» A FOSSIL communications driver (BNU/X00 or 100% compatible) ■» DOS 3.0+, OS/2 2.0+/Warp 3.0+, Win 3.0+, DV 2.0+, or Win '95 ■» DOOR.SYS or DORINFO1.DEF (produced by your BBS program) ■» A terminal supporting ANSI emulation (user only) ■» 300-500k on your hard disk (plus space for taglines + dictionary) ┌───────────────────────────────────────────────────────────────────────┐ │ ░░░░░ │ Installation │ ░░░░░ │ └───────────────────────────────────────────────────────────────────────┘ ■» Step-by-Step Instructions ────────────────────────────────────────────────────────────────── For quick and easy reference, complete, step-by-step installation instructions have been included a separate file, INSTALL.DOC. Specific instructions have also been included for installing TurboEDIT with RA (INS_RA.DOC), Synchronet (INS_SYNC.DOC), or EzyCom (INS_EZY.DOC). ■» Command-line Parameters ────────────────────────────────────────────────────────────────── ∙» -L Specify local mode (no dropfile required) ∙» -P<path> Specify path to your dropfiles, MSGTMP., MSGINF., etc. If you're not running TurboEDIT from your dropfile path, you MUST use this parameter. ∙» -N<#> Specify node, replace <#> with the number. ∙» -1 Force DORINFO1.DEF (do not use DORINFO2.DEF for node 2, etc.). ∙» -! Use DOOR.SYS instead of DORINFOx.DEF. ∙» -@<x> Force multitasker, replace <x> with one of the following: D = DESQview W = Windows N = NetWare 2 = DoubleDOS O = OS/2 X = Force NO detection If you don''t use this parameter, the multitasker will be detected. ∙» -% Force flushing of modem buffers after every modem write. NOT usually used, slows down OS/2 and Win95 horribly. ∙» -S<###> Release timeslice every <###>/100ths of a second (default is 100/100ths, or every 1 second) when NOT idle. If TurboEDIT is running slow, play around with this. ∙» -I<###> Release timeslice every <###>/100ths of a second (default is 100/100ths, or every 1 second) when idle (waiting for a keypress, etc). If TurboEDIT is running slow, play around with this. ∙» -F<###> Force the user to write <###> number of lines before saving. The user cannot abort the message. Useful if your users *must* write you a new user message, etc. ∙» -T<filename> Use alternate message text file (defaults to "MSGTMP."). For example, if you wanted to read from and write to MYMSG.TXT, use -FMYMSG.TXT. ∙» -M<filename> Use offline mail reader compatibility mode (see section on Offline Mail Readers). ■» Quick How-To ────────────────────────────────────────────────────────────────── In short, just decompress TurboEDIT into it's own directory, and run TESETUP.EXE. After setting up your preferences, TurboEDIT can be run by executing TEDIT.EXE -P<bbspath>. ┌───────────────────────────────────────────────────────────────────────┐ │ ░░░░░ │ Environment Variable │ ░░░░░ │ └───────────────────────────────────────────────────────────────────────┘ After receiving numerous requests for a better configuration file search routine, we've added support for a TurboEDIT environment variable, indicating the full path to TEDIT.CFG. * NOTE: Usually, you should NOT have to use the TEDIT environment variable, as TurboEDIT can usually find its configuration file by itself. If you are having problems with TurboEDIT not being able to locate TEDIT.CFG, add the following line to your AUTOEXEC.BAT (or BBS batch file, whatever): SET TEDIT=C:\RA\TEDIT Of course, if C:\RA\TEDIT is not the path to your TEDIT.CFG, you would have to change the SET command appropriately. ┌───────────────────────────────────────────────────────────────────────┐ │ ░░░░░ │ In-Depth Configuration │ ░░░░░ │ └───────────────────────────────────────────────────────────────────────┘ The following is a step-by-step breakdown of what each option in TurboEDIT's setup program is used for, and how to use it. ■» General Setup ══════════════════════════════════════════════════════════════════ -» Miscellaneous Setups ─────────────────────────────────────────────────────────────── ∙» TurboEDIT Tearline ~~~~~~~~~~~~~~~~~~ ° Long Sig - TurboEDIT appends a one-line tearline, i.e. "TurboEDIT v#.##x [MSP96]" ° Short Sig - TurboEDIT does NOT append a one-line sig, but instead adds the text "[TE]" (or "[TE+]" in the reg'd ver) to the beginning of the tag- line, i.e. "... [TE] Tagline would be here" ° None - No tearline, no [TE]. (Reg'd only). ∙» RemoteAccess BBS ~~~~~~~~~~~~~~~~ TurboEDIT includes many special features for RemoteAccess. ° Yes [RA v2.50] - You are using RemoteAccess v2.50. ° Yes - You are using RemoteAccess. ° No - You are not using RemoteAccess. ∙» BBS Path [RA] ~~~~~~~~~~~~~ If you are using RemoteAccess, TurboEDIT will take info from the RA message area & group files, MESSAGES.RA & MGROUPS.RA. This is the full path to these files. ∙» Registration UEC ~~~~~~~~~~~~~~~~ Upon registering TurboEDIT, you will be provided with a special number -- your UEC. You must enter it here exactly as it was provided for TurboEDIT's registered features to be enabled. ∙» Registration Name ~~~~~~~~~~~~~~~~~ Your name, exactly as it appeared on the registration form. ∙» Max Message Lines ~~~~~~~~~~~~~~~~~ The maximum number of message lines the user will allow the user to enter. Normally, this should be set to 4000 (the maximum. If there is not enough memory for the specified number of lines, TurboEDIT will allocate as much as it can. ∙» Screen Scroll Lines ~~~~~~~~~~~~~~~~~~~ When the user reaches the bottom of the page, the message will scroll up this many lines. ∙» Inactivity Timeout ~~~~~~~~~~~~~~~~~~ The number of seconds to allow the user to be inactive (not typing) before TurboEDIT should exit to the BBS. ∙» Low ASCII OK? (^]) ~~~~~~~~~~~~~~~~~~ This option has 3 possible settings: ° Yes - The user should be allowed to press ^] and then type any character (in- cluding low ASCII) to have that character inserted into the message text, i.e. ^] + ^E would insert a ^E character. ° Insert ^A Instead - When ^] is pressed, the ^A charac- ter should be inserted into the message text (useful for entering color codes under Synchronet). ° No - Disable the ^] key. ∙» Date/Time Format | ~~~~~~~~~~~~~~~~ | Sets the style of date and time you wish to have displayed. | | Options available: | DD/Mmm/YY HH:MMpm <i.e. 20/Apr/96 01:00pm> <- Default | DD/Mmm/YY HH:MM <i.e. 20/Apr/96 13:00> | | DD/MM/YY HH:MMpm <i.e. 20/04/96 01:00pm> | DD/MM/YY HH:MM <i.e. 20/04/96 13:00> | | MM/DD/YY HH:MMpm <i.e. 04/20/96 01:00pm> | MM/DD/YY HH:MM <i.e. 04/20/96 13:00> | | ∙» AutoSave | ~~~~~~~~ | Many SysOps have complained of losing their 10-page almost- | complete messages when some user on the other node locks up | their system by running a bad program. | | To assist in retrieving messages in the event of a crash, | TurboEDIT can now save the user's message to a temporary | file every 2 minutes. | | This temporary file, AUTOSAVE.TE!, is located in your BBS | system (or node) path. After recovering from the crash, | simply import the message back into TurboEDIT, and continue | editing. | | When exiting TurboEDIT, AUTOSAVE.TE! is deleted if the mess- | age was successfully saved or aborted. | -» Local Login Defaults ─────────────────────────────────────────────────────────────── This section refers to the defaults which should be used during a local login, when no dropfile can be found. ∙» BBS Name ~~~~~~~~ The name of your BBS. ∙» User Name ~~~~~~~~~ The name of the user to assume is logged in. ∙» User Location ~~~~~~~~~~~~~ The city/state the user is assumed to be from. ∙» Security Level ~~~~~~~~~~~~~~ The security level to give the locally logged in user. ∙» Time Limit ~~~~~~~~~~ The number of minutes to grant the user. -» Reply Configuration ─────────────────────────────────────────────────────────────── ∙» Max Quoted Text % ~~~~~~~~~~~~~~~~~ This option prevents users from using too much quoted text in their messages. If the user has more quoted text than this amount, he/she will be stopped before he/she saves the message to disk. ∙» Quote % Handling ~~~~~~~~~~~~~~~~ This option controls how TurboEDIT handles too much quoting in messages when the user goes over the limit, as set above. ° Inform user he/she is over the limit: This setting simply tells the user that he/she is over the quoting limit, and asks him if he would like to go back and remove some of the quoted text. ° Force user to remove quoted text: This setting forces the user to remove some of the quoted text (and bring himself below the limit) before TurboEDIT will allow him to save the message. ∙» Quote Window Key ~~~~~~~~~~~~~~~~ Under some operating systems and/or terminals, Ctrl+Q will will not work properly, & therefore quoting will be rendered impossible. This option allows you to change the quote key to ^W, therefore re-enabling quoting. ∙» Quote Window Size ~~~~~~~~~~~~~~~~~ Some SysOps/users have complained that the quote window is too small. With this option, you can change the size of the quote window to however many lines you like. ∙» Reply Header Text ~~~~~~~~~~~~~~~~~ Some systems use reply headers that differ from the standard " * In a message originally to x, x said:". This causes a problem in that TurboEDIT will not be able to distinguish the header from regular quoted text, and will quote it. For example: SB> * In a message originally to John Smith, Bob Jones said: In this example, the "SB>" quote shouldn't have been added. Make sure you enter your reply header EXACTLY as it is saved in your BBS program's setup to correct this problem. -» Memory/Disk Swapping ─────────────────────────────────────────────────────────────── ∙» Swap to EMS ~~~~~~~~~~~ This option allows you to toggle swapping to EMS (when shelling to DOS or running a utility). ∙» Swap to XMS ~~~~~~~~~~~ This option allows you to toggle swapping to XMS (when shelling to DOS or running a utility). ∙» Swap to Disk ~~~~~~~~~~~~ This option allows you to toggle swapping to disk (when shelling to DOS or running a utility). ∙» Swap Order ~~~~~~~~~~ This option allows you to set the order in which TurboEDIT should try to swap out (EMS/XMS/Disk, or XMS/EMS/Disk). -» Alt-Fx Macros ─────────────────────────────────────────────────────────────── This submenu allows you to configure up to 10 function keys to use (on the local keyboard only) while in TurboEDIT. Function keys may be used to run external programs, import textfiles, and insert text strings into messages. ∙» Running External Programs ~~~~~~~~~~~~~~~~~~~~~~~~~ To run an external program as a macro, select "Run an External Program" for the Macro Type. For the macro text, enter the full path and filename of the program to run, plus any parameters the program requires. In addition, any of the following parameters may be used: *P Inserts the number of the active com port. *T Inserts the first name of the recipient. *F Inserts the first name of the sender. *B Inserts the current baudrate. *O Inserts the last name of the recipient. *I Inserts the last name of the sender. *N Inserts the current node number. *S Inserts the subject of the message. *C Inserts the full path to COMMAND.COM (used for run- batch files). *$ Forces TurboEDIT to export the message text to a file named MSGDATA.TXT prior to executing the macro, and then forces it to read MSGDATA.TXT back in after running the external program. This feature allows the SysOp to edit the message in an external editor (such as EDIT) in local mode. For example: C:\DOS\EDIT MSGDATA.TXT *$ Would allow you to use DOS's EDIT to modify the mes- sage text. After saving your changes and exiting EDIT, TurboEDIT would read MSGDATA.TXT back in and allow you to continue editing, save, etc. This feature is not mentioned in TESETUP. It's one of the bonuses of reading the docs. =) *X This code is similar to *$, except that it only ex- ports the file -- it does not automatically reimport it. You must also specify a filename to export the message to, for example: C:\DOS\EDIT MYMSG.TXT *XMYMSG.TXT Would allow you to use DOS's EDIT to modify the mes- sage text. After saving your changes and exiting, however, the file would NOT be automatically re- imported, unless you use the *Y parameter. *Y Tells TurboEDIT to re-import a file (exported with the *X parameter) after the external program has been executed. ∙» Insert Text String Into Message ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This type of macro simply inserts a line of text into your message. For example, if you had a greeting that you always used, you might set Alt+F1 to the following: Hi there, *T *O, this is *F *I! Then, when you pressed Alt+F1, the following greeting would appear (if your name was Steve Blinch and you were writing to someone named Michael Helliker): Hi there, Michael Helliker, this is Steve Blinch! As shown above, almost all of the Run External Program par- ameters are available, except for *C, *$, *X, & *Y. ∙» Import Textfile Into Message ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Choosing "Import Textfile Into Message" works almost exact- ly like pressing F3, except that you must set the macro text to the full path & filename of the file to import. Then, by hitting one simple Alt+Fx key, you you can import a textfile, and don't have to enter the filename each time. -» Security Level Setups ─────────────────────────────────────────────────────────────── ∙» Import Security ~~~~~~~~~~~~~~~ Sets the minimum security required to import files into the editor from the SysOp's hard drive with F3 or /I. ∙» Export Security ~~~~~~~~~~~~~~~ Sets the minimum security required to export files from the editor on to the SysOp's hard drive with F2 or /E. ■» Toggles ══════════════════════════════════════════════════════════════════ -» Allow Taglines ─────────────────────────────────────────────────────────────── Taglines are one-line quotes, usually humourous in nature, that are added to messages "just because". ° Yes - Allow users to add taglines to their msgs. ° No - Do not allow users to use taglines. [RA] In the registered version, you may decide which areas allow taglines and which do not. -» Text Phrase Expand ─────────────────────────────────────────────────────────────── Text Phrase Expansions are used to expand acronyms or short forms of words into their full phrases. For example, you could expand the text "DOS" into "Disk Operating System" or "L8r" into "Later". ° Yes - Allow users to use phrase expanding. ° No - Do not allow users to use phrase expanding. [RA] In the registered version, you may decide which areas allow phrase expansion and which do not. -» Tagline Keywords ─────────────────────────────────────────────────────────────── Tagline keywords allow the user to only use taglines containing certain words or phrases. This is useful if you have a large list of taglines covering many topics, and the user only wants taglines on a certain topic. ° Yes - Allow users to use tagline keywords. ° No - Do not allow users to use tagline keywords. [RA] In the registered version, you may decide which areas allow tagline keywords and which do not. -» Censor Messages ─────────────────────────────────────────────────────────────── Message censoring is useful if you do not allow strong language to be used on your BBS, or if you have certain public/echomail areas in which certain language would be inappropriate. [RA] In the registered version, you may decide which areas require censoring and which do not. -» User Signatures ─────────────────────────────────────────────────────────────── User signatures allow the user to enter his signature into TurboEDIT once, after which TurboEDIT can automatically append that signature to any message he writes. If you wish to prevent users from using signatures (some echomail areas, for example, disallow signatures) simply set this to 'No'. [RA] In the registered version, you may decide which areas allow signatures and which do not. -» High ASCII Filter ─────────────────────────────────────────────────────────────── Some echomail networks discourage or disallow the use of high ASCII characters in their areas. Using the High ASCII Filter in conjunction with FILTER.CTL, all High ASCII may either be removed or converted into similar Low ASCII characters. [RA] In the registered version, you may decide which areas require filtering and which do not. ■» Color Setup ══════════════════════════════════════════════════════════════════ -» Frame 1, Frame 2, Frame 3, and Frame 4 ─────────────────────────────────────────────────────────────── These settings control the colors of the frames around the info boxes at the top and bottom of the TurboEDIT editing screen. -» Fade ─────────────────────────────────────────────────────────────── This setting controls the color of the fading in the corners of the top info box (█▓▒░, etc). -» Capital, Lowcase, Symbols, Digits ─────────────────────────────────────────────────────────────── These settings control the color of general text. Capital is the color of capitalized text (A-Z), Lowcase is the color of lowercase text (a-z), Symbols is the color of any non-alpha- numeric characters (`~!@#$%^&*()-_=+[{]}\|;:'",<.>/?, and any high-ascii characters), and Digits is the color of the digits (0-9). -» Inp-Capital, Inp-Lowcase, Inp-Symbols, Inp-Digits ─────────────────────────────────────────────────────────────── These settings control the color of information fields (From, to, date, time, subject, etc). ■» Tags/SpellChk ══════════════════════════════════════════════════════════════════ -» Tagline Datafile Name ─────────────────────────────────────────────────────────────── This is the full path & filename of the tagline datafile. This is a plain ASCII text file containing one tagline per line. If no path is specified, TurboEDIT looks in it's own directory. If no datafile is specified, TurboEDIT exits with an error. -» Censor Taglines ─────────────────────────────────────────────────────────────── This in an extension of the message censor option. If you want to ensure that all messages leave your board 100% clean, enable this option and TurboEDIT will apply censoring to your taglines as well as the message body. -» # Taglines On Screen ─────────────────────────────────────────────────────────────── This setting allows you to control how many taglines the user may choose from at a time in the tagline menu. -» Use Spellchecker ─────────────────────────────────────────────────────────────── This option allows you to configure whether or not users may spellcheck their messages. See the section below on Spell Checking. -» Dictionary Path ─────────────────────────────────────────────────────────────── This is the full path (without filename) to the spellchecker dictionary file (TE_DIC.*). This path will also be used to store the personal user dictionaries (named LAST.1ST, where LAST is the first 8 digits of the user's last name, and 1ST is the first 3 digits of the user's first name). ■» Miscellaneous ══════════════════════════════════════════════════════════════════ -» Censor Setup ─────────────────────────────────────────────────────────────── This is a list of words which you do NOT want to appear in any censored areas. If a user tries to post a message containing any of these words, they will be replaced, letter by letter, with the Censor Overstrike Char. -» Overstrike Setup ─────────────────────────────────────────────────────────────── Configures the way TurboEDIT handles text censoring. ·» Censor Overstrike Char ~~~~~~~~~~~~~~~~~~~~~~ Sets the character that TurboEDIT uses to replace censored text. Example: Censor Cover Char = * Words to Censor = FRUIT Text typed by user = "I've lost my fruit cake." Text after censor = "I've lost my ***** cake." ∙» Use Symbols Instead (!@#$) ~~~~~~~~~~~~~~~~~~~~~~~~~~ Sets whether or not to use random symbols (!@#$%*) to re- place censored text, rather than using the Censor Over- strike Char Example: Use Symbols Instead = YES Words to Censor = FOAM Text typed by user = "There's no place like foam." Text after censor = "There's no place like $%#@." ∙» Only Overstrike Vowels ~~~~~~~~~~~~~~~~~~~~~~ Sets whether TurboEDIT should censor the entire word or only the vowels. Example: Only Strike Vowels = YES Use Symbols Instead = NO Words to Censor = FRUIT Text typed by user = "I can't find my fruit spoon." Text after censor = "I can't find my fr**t spoon." Use Symbols Instead = YES Text after censor = "I can't find my fr@!t spoon." -» Phrase Expand ─────────────────────────────────────────────────────────────── ∙» Original Typed Text ─────────────────────────────────────────────────────────── This column should contain the text that you wish TurboEDIT to expand. ∙» New Replacement Text ─────────────────────────────────────────────────────────── This column should contain the text that you wish TurboEDIT to replace the original text with. Example: Original Text = DOS Replacement Text = Disk Operating System In this example, any time the user typed in "DOS", it would be replaced with the text "Disk Operating System". ∙» Adding MORE Expansions ─────────────────────────────────────────────────────────── Due to the fact that some SysOps like to have more than 10 expansions at a time, we've added a new Expansion Con- trol File, EXPAND.CTL. This file allows you to add up to 256 more phrase expansions to TurboEDIT. Instructions for use are included inside the file. ∙» Built-in Expansions ─────────────────────────────────────────────────────────── TurboEDIT has several built-in expansions that need not be included in TESetup or EXPAND.CTL. They are: TBANK -> "TurboBANK" @DATE@ -> Today's date. TCHAT -> "TurboCHAT" @TIME@ -> Current time. TLIST -> "TurboLIST" @SYSOP@ -> The SysOp's name. TCHEK -> "TurboCHEK" @BBS@ -> The BBS name. TPAC -> "TurboPAC" @TO@ -> The recipient's name. TVOTE -> "TurboVOTE" @FROM@ -> The sender's name. TNEWS -> "TurboNEWS" @RE@ -> The message subject. TEDIT -> "TurboEDIT" @VER@ -> TurboEDIT version #. There are a few others as well, mainly used by us at Mikerosoft, which are not worth mentioning. -» User Editor ─────────────────────────────────────────────────────────────── Allows the SysOp to edit the configurations of each individual user (if registered). Upon selecting this option, the SysOp will be prompted for a username. If the user exists in the userbase, the SysOp will be shown a screen similar to the one shown when ^K is pressed in TurboEDIT. From there, the SysOp may edit the options as desired. ┌───────────────────────────────────────────────────────────────────────┐ │ ░░░░░ │ Using TurboEDIT │ ░░░░░ │ └───────────────────────────────────────────────────────────────────────┘ The following keys and options are available when using TurboEDIT: ■» Import File F2 or /I ────────────────────────────────────────────────────────────────── Brings up a window (local side only) prompting for a filename. If the file exists, it will be imported into the message text. TurboEDIT has an internal maximum of 4000 lines of message text (or whatever you set it to in TESetup). If the text file exceeds this limit, it will be truncated. Note: Invoked by pressing F3 on the REMOTE keyboard, or typing /I at the beginning of a line on either the local or remote keyboards. ■» Export File F3 or /E ────────────────────────────────────────────────────────────────── Brings up a window prompting for a filename. The message being edited will be exported to this file. Note: Invoked by pressing F2 on the LOCAL keyboard, or typing /E at the beginning of a line on either the local or remote keyboards. ■» Word Left ^A or ^Left ────────────────────────────────────────────────────────────────── Moves the cursor one word to the left. ■» Reformat Paragraph ^B ────────────────────────────────────────────────────────────────── Reformats the current paragraph. ■» PageDown ^C or PageDown ────────────────────────────────────────────────────────────────── Moves the cursor down one page. ■» Cursor Right ^D or Right Arrow ────────────────────────────────────────────────────────────────── Moves the cursor once space to the right. If at the end of the line, the cursor moves down to the next line, and returns to the first column. ■» Cursor Up ^E or Up Arrow ────────────────────────────────────────────────────────────────── Moves the cursor up one line. ■» Word Right ^F or ^Right ────────────────────────────────────────────────────────────────── Moves the cursor one word to the right. ■» Delete ^G or Del ────────────────────────────────────────────────────────────────── Erases the character under the cursor. ■» Backspace ^H or Backspace ────────────────────────────────────────────────────────────────── Erases the character to the left of the cursor, and moves the character one space to the left. If at the beginning of the line, the cursor is moved to the end of the line above. ■» Cursor Tab ^I or Tab ────────────────────────────────────────────────────────────────── Moves the cursor right, to the next tab stop. Tab stops are every eight characters. ■» Join Lines ^J ────────────────────────────────────────────────────────────────── Joins the current line with the next line. ■» User Configuration ^K ────────────────────────────────────────────────────────────────── In the unregistered version, allows the user to enter his/her per- sonal signature, which may be appended to each message the user writes. In the registered version, loads up the user configuration menu, allowing the user to define his/her own editor preferences. ∙» Expand Text ~~~~~~~~~~~ Allows the user to define his/her OWN personal Phrase Expan- sions. This works exactly the same way as in TurboEDIT Setup. ∙» Use Taglines ~~~~~~~~~~~~ Allows the user to decide whether or not to use taglines. ∙» Use Expand ~~~~~~~~~~ Allows the user to decide whether or not to use Phrase Expan- sions. ∙» Use Keywords ~~~~~~~~~~~~ Allows the user to decide whether or not to use tagline key- words. ∙» Auto Tagline ~~~~~~~~~~~~ Automatically picks a random tagline from the file and appends it to the user's message after each message post. No user interaction is required, everything is automatic. ∙» Your Signature ~~~~~~~~~~~~~~ Allows the user to enter his/her personal signature, which may be appended to each message he/she writes. ∙» Colors ~~~~~~ Exactly the same as in TurboEDIT Setup, this allows the user to customize TurboEDIT's colors to his/her own preference. ∙» Tag Keywords ~~~~~~~~~~~~ This allows the user to set specific text to search for when loading the keyword file. This way, if he/she only wants tag- lines containing, say, the word "JOE", one of his/her tag keywords could be "JOE", and only taglines containing the word "JOE" would appear. ■» Beginning of Line ^L or Home ────────────────────────────────────────────────────────────────── Moves the cursor to the beginning of the line. ■» Newline ^M or Enter ────────────────────────────────────────────────────────────────── Splits the current line at the cursor, and moves it (and the cursor) down to the next line. If there is no text to split, the cursor is simply moved down to the beginning of the next line. ■» Split Line ^N ────────────────────────────────────────────────────────────────── Splits the line at the cursor, and moves the trailing portion down to the next line. ■» Redisplay ^O ────────────────────────────────────────────────────────────────── Redraws the current screen. ■» End Of Line ^P or End ────────────────────────────────────────────────────────────────── Moves the cursor to the end of the line. ■» Quote Window ^Q or ^W ────────────────────────────────────────────────────────────────── If the user is replying to a message, this opens up the quote win- dow, allowing the user to quote what the other users said in his message. The user may use the Up/Down/PgUp/PgDn/Home/End keys and <enter> to choose which line or lines he/she wishes to quote. ■» PageUp ^R or PageUp ────────────────────────────────────────────────────────────────── Moves the cursor up one page. ■» Cursor Left ^S or Left Arrow ────────────────────────────────────────────────────────────────── Moves the cursor once space to the left. ■» Delete Word ^T ────────────────────────────────────────────────────────────────── Erases the word nearest the cursor. ■» Help ^U ────────────────────────────────────────────────────────────────── Displays TurboEDIT's online help. ■» Insert Mode ^V or Insert ────────────────────────────────────────────────────────────────── Toggles insert mode on or off. In insert mode, characters are in- serted into the current line at the cursor when a key is pressed. When in overstrike mode (opposite of insert mode) characters are typed over existing text, and the existing text is destroyed. In overstrike mode, "[Overstrike]" is displayed at the bottom of the screen. ■» Cursor Down ^X or Down Arrow ────────────────────────────────────────────────────────────────── Moves the cursor down one line. ■» Erase Line ^Y ────────────────────────────────────────────────────────────────── Erases the current line. ■» Save Message ^Z ────────────────────────────────────────────────────────────────── Retrieves a tagline (if enabled), censors the message (if enabled) and saves the message to disk. ■» Menu ^[ or Escape ────────────────────────────────────────────────────────────────── Brings up the TurboEDIT function menu. This allows the user to select [Save], [Abort], [Resume], or [Help], using the arrow keys. ■» Extended Key ^] ────────────────────────────────────────────────────────────────── TurboEDIT setup allows you to select one of two possible uses for the ^] key. The first one is to allow the user to enter any ASCII character directly into the message. To do this, the user must press ^], then enter any ASCII character (except 0, 7, 8, 9, 10, 13, 19, or 25). The second use is to immediately insert a ^A character into the message. This allows Synchronet users to insert color into their messages. Optionally, this key can be disabled altogether, so that nothing happens when it is pressed. ══════════════════════════════════════════════════════════════════ ■» Shortcut Commands ────────────────────────────────────────────────────────────────── In addition to the above keys, TurboEDIT also allows the user to use Slash (/) commands. To enter a slash command, the cursor must be positioned on the FIRST (leftmost) column of the editor. Press / followed by one of the following keys: A ∙» Abort Message (Same as Esc, A) S ∙» Save Message (Same as Ctrl+Z or Esc, S) E ∙» Export Message (Same as F2 from local keyboard) I ∙» Import File (Save as F3 from local keyboard) C ∙» Configuration (Same as Ctrl+K) H ∙» Editor Help (Same as Ctrl+U or Esc, H) Q ∙» Quote Window (Same as Ctrl+W, Ctrl+Q, or Esc, Q) ┌───────────────────────────────────────────────────────────────────────┐ │ ░░░░░ │ Prohibitions from Posting │ ░░░░░ │ └───────────────────────────────────────────────────────────────────────┘ If your BBS carries echomail areas, you may, from time to time, be forced to remove a user's access to an echomail network for a certain period of time (i.e., due to the user misbehaving in the echo and being suspended by a moderator, etc). For this reason, TurboEDIT has the ability to read the bad user control file, BADUSER.CTL. Instructions for use are included inside the control file. ┌───────────────────────────────────────────────────────────────────────┐ │ ░░░░░ │ SpellChecker │ ░░░░░ │ └───────────────────────────────────────────────────────────────────────┘ The spellchecker may now be used in the evaluation (unregistered) version of TurboEDIT. TurboEDIT now allows users to check the spelling of their messages prior to saving them. To check the validity of a word, TurboEDIT opens its dictionary of over 50,000 words and attempts to locate the word in question. If it cannot find the word, it assumes the word is spelled incorrectly. If TurboEDIT finds that the word is spelled incorrectly, it will pause the spellchecker, highlight the word it cannot find, & present the user with the options listed below. ■» Spellchecker Options ────────────────────────────────────────────────────────────────── Skip ∙» Ignore the word and move on. Useful if the word is, for example a name, address, or another word that the user believes is spelled correctly. Skip all ∙» Ignore the word and any further occurances of the word in the message, and move on. Add word ∙» Adds the highlighted word to the user's personal dictionary. Useful if the user knows that the word is spelled correctly. The dictionary is large, but it obvious- ly cannot contain *every* word in the English lang- uage, so some words are bound to be missing. Change Word ∙» Allow the user to enter a new spelling for the word. This is the main purpose of the spellchecker. The highlighted (misspelled) word will be replaced with the newly spelled word. Quit ∙» Stop, abort spellchecking. ────────────────────────────────────────────────────────────────── In order to use the spellchecker, you must have the TurboEDIT Spellchecker Dictionary file. This file is distributed separately from TurboEDIT to reduce the size of the archive. If you would like a copy of the Spellchecker Dictionary, it should be available as "TEDIC???.EXE" (where ??? is the version number) from wherever you received TurboEDIT. ┌───────────────────────────────────────────────────────────────────────┐ │ ░░░░░ │ User Signatures │ ░░░░░ │ └───────────────────────────────────────────────────────────────────────┘ Many users have their own personal one to five line signature that they always use to sign their messages. For added convenience, TurboEDIT now has the ability to store each user's signature and automatically append it to the end of each message he/she writes. To enter his/her signature, the user should load TurboEDIT and press ^K. In the unregistered version, this will jump directly to the sig- nature screen. In the registered version, this will jump to the user configuration menu, from which the signature screen can be loaded by pressing I. The user may then enter a one to five line signature. Whenever the user saves a message, he/she will be asked whether or not he/she would like to append his/her signature to the message. If the user selects Yes, the signature is appended to the message, and then the message is saved. ┌───────────────────────────────────────────────────────────────────────┐ │ ░░░░░ │ Taglines │ ░░░░░ │ └───────────────────────────────────────────────────────────────────────┘ If enabled, TurboEDIT will search through the tagline datafile for five random taglines, and present the following options: ■» Highlight Bar Down Down or 2 ────────────────────────────────────────────────────────────────── Moves the highlight bar down one tagline. ■» Highlight Bar Up Up or 8 ────────────────────────────────────────────────────────────────── Moves the highlight bar up one tagline. ■» Random Tagline R ────────────────────────────────────────────────────────────────── Selects one of the five taglines randomly and appends it to the user's message. ■» Enter New E ────────────────────────────────────────────────────────────────── Allows the user to enter his/her own tagline manually, and app- end it to the message. ■» Keyword Search K ────────────────────────────────────────────────────────────────── Prompts the user for a keyword and does a search for any tagline containing that keyword. Works exactly like the Keyword option in the User Config menu and in TESetup, but allows the user to do instant searches. ■» New Picklist N ────────────────────────────────────────────────────────────────── Re-scans the tagline file and retrieves five new taglines, in case the user doesn't like the first selection he's given. ■» IntelliTag I ────────────────────────────────────────────────────────────────── This feature causes TurboEDIT to check the message's "Subject" field and try to identify the general topic of the message. It will then scan the tagline datafile and see if it can find any taglines relevant to the topic of the message. ■» Confirm Tagline Enter ────────────────────────────────────────────────────────────────── Appends the highlighted tagline to the user's message. ■» Save Without Tagline Esc ────────────────────────────────────────────────────────────────── Saves the message without a tagline. A few sample taglines have been included in the file TAGLINES.TAG, but you will probably want to get more if you intend to use this feature. The sample taglines provided are from the Fido Backbone Taglines Conference. Thanks to all who posted! ┌───────────────────────────────────────────────────────────────────────┐| │ ░░░░░ │ Language Editor │ ░░░░░ │| └───────────────────────────────────────────────────────────────────────┘| | As of v1.50a, TurboEDIT has a SysOp-configurable language file, from | which it retrieves almost all text displayed to the user. With this | file, TurboEDIT may be translated into another language and used on | systems which do not use English as the primary language. | | The editor (LANGEDIT.EXE) is very simple to use, so no explanation | should be necessary (aside from the help bar at the top of the | screen). | ┌───────────────────────────────────────────────────────────────────────┐ │ ░░░░░ │ Screen Header │ ░░░░░ │ └───────────────────────────────────────────────────────────────────────┘ TurboEDIT now gives you the option of using the header control file, HEADER.CTL, to customize the top 6 lines of the screen (where the sender's name, recipient's name, date/time, subject, area name, etc. are displayed). The header may not exceed 6 lines in length (when displayed). All ANSI codes are available except for ESC[x;xH, ESC[xA, ESC[xB, ESC[xJ, and ESC[xR. The text and control codes in this file may not exceed 10 lines. Any text after 10 lines (or a '%') is ignored. Control Code Returns ───────────────────────────────────────────────────────────────────── @FROM@ The name of the sender of the message @TO@ The name of the recipient of the message @AREA@ The name of the area being posted in @SUBJ@ The subject of the message @DATE@ The current date/time @MSG@ The message number @P@ Private: " Yes " or " No " ───────────────────────────────────────────────────────────────────── |NC Frame Color 1 |HC Frame Color 2 |PC Frame Color 3 |BC Frame Color 4 |FZ "Fade" Color |FC Capital Letter Color |FL Lowercase Letter Color |FS Symbol Color |FD Digit Color |IC Capital Letter Color (Input fields) |IL Lowercase Letter Color (Input fields) ───────────────────────────────────────────────────────────────────── In most cases, you will want each control code to be justified in a field of a certain size. For example, the second line of the default header: │█▓▒░ From: @FROM...................@ Date: @DATE.............@ ░│ This would be displayed as: │█▓▒░ From: _Steve_Blinch____________ Date: _04-Mar-96_01:20am_ ░│ (the _'s above represent colored spaces.) The entire size of the control code, from opening @ to closing @, is the actual size of the field of data that will be displayed on the screen. If this seems complicated, just play around with it -- it's really not too difficult! This is a registered-only feature. ┌───────────────────────────────────────────────────────────────────────┐ │ ░░░░░ │ Offline Mail Readers │ ░░░░░ │ └───────────────────────────────────────────────────────────────────────┘ Due to popular request, TurboEDIT may now be used with offline mail readers such as Blue Wave to reply to messages. To use TurboEDIT as an offline mail editor, it must be invoked with the -M<filename> parameter, where <filename> is the name of the file that the mail reader stores the message text in. ■» Setting Up TurboEDIT with Blue Wave ────────────────────────────────────────────────────────────────── Assuming your path to TurboEDIT is C:\BWAVE\TEDIT, the following exact setups may be used. If your path differs, simply change it as you go. Run Blue Wave, and select Setup/Configure Mail Reader. Then, change the following two options: ══════════════════════════════════════════════════════════════════ ∙» External └> Message Editor Cmd C:\BWAVE\TEDIT\TEDIT.EXE -M@F ∙» Global └> Memory Swapping Options └> Swap on Shell to Msg Editor Yes ══════════════════════════════════════════════════════════════════ Also, please be sure to run TESetup and go to: ∙» General Setup └> Local Defaults And enter your BBS name, default user name, location, security level and time limit. ┌───────────────────────────────────────────────────────────────────────┐ │ ░░░░░ │ ANSI Required │ ░░░░░ │ └───────────────────────────────────────────────────────────────────────┘ TurboEDIT, being a full screen message editor, requires that the user supports ANSI graphics to run. This should be no surprise, as there are very few (if any) FSEd's out there that do not require ANSI. ┌───────────────────────────────────────────────────────────────────────┐ │ ░░░░░ │ Support, Distribution, and Contacting the Author │ ░░░░░ │ └───────────────────────────────────────────────────────────────────────┘ ■» Getting TurboEDIT Upgrades ────────────────────────────────────────────────────────────────── Please see DISTRIB.TXT for a full list of our support & distrib- ution sites, along with our Webpage and FTP sites. TurboEDIT is available for F'req via 1:153/554 with the magic name of "TEDIT" (without the quotes), 24 hours/day, 33600 BPS. ■» Contacting The Author ────────────────────────────────────────────────────────────────── The author can be contacted via any of the following (in order of reliability and recommendation): Internet E-mail: fvhelm57@ucfv.bc.ca Netmail : Crash or Route to Steve Blinch, 1:153/554.1 Fido Backbone : Post to Steve Blinch in the RA_UTIL conference ┌───────────────────────────────────────────────────────────────────────┐ │ ░░░░░ │ Credits │ ░░░░░ │ └───────────────────────────────────────────────────────────────────────┘ References have been made to following software throughout this file and the rest of TurboEDIT's documentation. Each have been developed by and/or are trademarks of the following authors or companies: Blue Wave: Cutting Edge Cmputing; BNU: David Nugent; DESQview: Quarterdeck Office Systems; Windows, Windows 95, DOS, EDIT: Microsoft Corporation; EzyCom: Peter Davies; OS/2, OS/2 Warp: IBM Corporation; RAR: Eugene Roshal; RemoteAccess: Andrew Milner and Wantree Development. The author would like to thank the following people for assistance in creating TurboEDIT (in one way or another)... Mike, Dave, John, Zsolt, and Ryan (the beta team, see below), Damien Sam (webpage manager), Oscar Olsson (FTP provider, Sweden), and all other SysOps and users who contributed suggestions, bug reports, and ideas. The beta team is: Name BBS Phone Number Fido Addr ───────────────────────────────────────────────────────────────────── Michael Helliker Mikerosoft BBS +1-604-864-8160 1:153/554 Zsolt Hengsperger Something For Everyone +1-604-723-7101 1:3410/210 Ryan Rivas StoneKeep +1-407-380-9529 1:363/321 John Moeller PC MUNCHLAND +1-706-561-8043 1:3613/4 David Desrosiers hacker heaven bbs -temporarily unavailable- ───────────────────────────────────────────────────────────────────── For a list of our support sites, please refer to DISTRIB.TXT. ┌───────────────────────────────────────────────────────────────────────┐ │ ░░░░░ │ Info │ ░░░░░ │ └───────────────────────────────────────────────────────────────────────┘ TurboEDIT was created in about two months, and is just over 5500 lines long (plus a 2300+ line utility unit, a 3100+ line communica- tions unit, and a 2500 line setup program). It was programmed using Turbo Pascal v7.0, and most importantly, it's Canadian! (eh?) ┌───────────────────────────────────────────────────────────────────────┐ │ ░░░░░ │ The End │ ░░░░░ │ └───────────────────────────────────────────────────────────────────────┘